Product
Introducing Ruby Support in Socket
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
@aws-cdk/cfnspec
Advanced tools
@aws-cdk/cfnspec is an npm package that provides CloudFormation resource specifications for AWS CDK. It allows developers to work with AWS CloudFormation resources in a programmatic way, enabling the creation, modification, and validation of AWS infrastructure as code.
Loading CloudFormation Specifications
This feature allows you to load the CloudFormation resource specifications. The `spec` object contains detailed information about all the AWS resources supported by CloudFormation.
const cfnspec = require('@aws-cdk/cfnspec');
const spec = cfnspec.spec;
console.log(spec);
Accessing Resource Types
This feature allows you to access the different resource types available in the CloudFormation specification. The `ResourceTypes` object contains metadata about each resource type.
const cfnspec = require('@aws-cdk/cfnspec');
const resourceTypes = cfnspec.spec.ResourceTypes;
console.log(Object.keys(resourceTypes));
Validating Resource Properties
This feature allows you to validate the properties of a specific resource type. For example, you can retrieve and inspect the properties of an S3 bucket.
const cfnspec = require('@aws-cdk/cfnspec');
const resourceTypes = cfnspec.spec.ResourceTypes;
const s3BucketProps = resourceTypes['AWS::S3::Bucket'].Properties;
console.log(s3BucketProps);
The `aws-sdk` package is the official AWS SDK for JavaScript, providing a comprehensive set of tools for interacting with AWS services. Unlike @aws-cdk/cfnspec, which focuses on CloudFormation specifications, `aws-sdk` allows you to directly interact with AWS services, making API calls to manage resources.
The `cloudformation-js-yaml-schema` package provides a JSON schema for AWS CloudFormation templates. It is useful for validating CloudFormation templates written in YAML or JSON. While it focuses on template validation, @aws-cdk/cfnspec provides a more comprehensive set of tools for working with CloudFormation specifications programmatically.
The `cdk` package is the AWS Cloud Development Kit, which allows you to define cloud infrastructure using a programming language. It provides higher-level abstractions for AWS resources, whereas @aws-cdk/cfnspec provides the raw CloudFormation specifications that can be used to build such abstractions.
To update the CloudFormation spec to the latest version, run:
npm run update
Any JSON hashes are alpha-sorted to make sure that only actual changes appear in diffs.
0.29.0 (2019-04-24)
app.run()
(#2300) (47ff448), closes #2289 awslabs/jsii#456Code
, CfnParametersCode
. (#2027) (4247966)MetricCustomization
to MetricOptions
.outputArtifact
and outputArtifacts
properties.inputArtifact(s)
and additionalInputArtifacts
properties were renamed to input(s)
and extraInputs
.outputArtifactName(s)
and additionalOutputArtifactNames
properties were renamed to output(s)
and extraOutputs
.CodeBuildBuildAction
and CodeBuildTestAction
were merged into one class CodeBuildAction
.JenkinsBuildAction
and JenkinsTestAction
were merged into one class JenkinsAction
.lambda.Function
no longer implements IEventRuleTarget
. Instead, use @aws-cdk/aws-events-targets.LambdaFunction
.sns.Topic
no longer implements IEventRuleTarget
. Use @aws-cdk/aws-events-targets.SnsTopic
instead.codebuild.Project
no longer implements IEventRuleTarget
. Use @aws-cdk/aws-events-targets.CodeBuildProject
.cdk.Root
construct has been removed. Use cdk.App
instead.stepfunctions.WaitProps
: the props seconds
, timestamp
, secondsPath
and timestampPath
are now duration
of a union-like class WaitDuration
(e.g. duration: WaitDuration.seconds(n)
)codedeploy.ServerDeploymentConfigProps
: the props minHealthyHostCount
and minHealthyHostPercentage
are now minimumHealthyHosts
of union-like class MinimumHealthyHosts
(e.g. minimumHealthyHosts: MinimumHealthyHosts.percentage(50)
)cloudformation.CustomResourceProps
: the props topicProvider
and lambdaProvider
are now provider
of union-like class CustomResourceProvider
(e.g. CustomResourceProvider.lambda(fn)
cloudformation.CustomResource
no longer extends CfnCustomResource
.ssm.ParameterProps
renamed to ssm.ParameterOptions
.aws-ec2.InstanceSize.None
was renamed to InstanceSize.Nano
vpc.selectSubnetIds(...)
has been replaced with vpc.selectSubnets(...).subnetIds
.FAQs
The CloudFormation resource specification used by @aws-cdk packages
The npm package @aws-cdk/cfnspec receives a total of 122,866 weekly downloads. As such, @aws-cdk/cfnspec popularity was classified as popular.
We found that @aws-cdk/cfnspec demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 4 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Socket is launching Ruby support for all users. Enhance your Rails projects with AI-powered security scans for vulnerabilities and supply chain threats. Now in Beta!
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.